nexpose 0.2.8 → 0.5.0

data/lib/nexpose/group.rb

@@ -8,35 +8,33 @@ module Nexpose
     #
     # @return [Boolean] Whether group deletion succeeded.
     #
-    def asset_group_delete(id)
+    def delete_asset_group(id)
       r = execute(make_xml('AssetGroupDeleteRequest', {'group-id' => id}))
       r.success
     end
 
-    alias_method :delete_asset_group, :asset_group_delete
-
-    # Retrieve a list of all asset groups the user is authorized to view or
+    # Retrieve an array of all asset groups the user is authorized to view or
     # manage.
     #
     # @return [Array[AssetGroupSummary]] Array of AssetGroupSummary objects.
     #
-    def asset_groups
+    def list_asset_groups
       r = execute(make_xml('AssetGroupListingRequest'))
 
-      res = []
+      groups = []
       if r.success
         r.res.elements.each('AssetGroupListingResponse/AssetGroupSummary') do |group|
-          res << AssetGroupSummary.new(group.attributes['id'].to_i,
-                                       group.attributes['name'].to_s,
-                                       group.attributes['description'].to_s,
+          groups << AssetGroupSummary.new(group.attributes['id'].to_i,
+                                       group.attributes['name'],
+                                       group.attributes['description'],
                                        group.attributes['riskscore'].to_f)
         end
       end
-      res
+      groups
     end
 
-    alias_method :asset_groups_listing, :asset_groups
-    alias_method :groups, :asset_groups
+    alias_method :groups, :list_asset_groups
+    alias_method :asset_groups, :list_asset_groups
   end
 
   # Summary value object for asset group information.
@@ -53,7 +51,7 @@ module Nexpose
     # @param [Connection] connection Connection to security console.
     #
     def delete(connection)
-      connection.asset_group_delete(@id)
+      connection.delete_asset_group(@id)
     end
   end
 
@@ -71,13 +69,11 @@ module Nexpose
     end
 
     def save(connection)
-      xml = %Q(<AssetGroupSaveRequest session-id='#{connection.session_id}'>)
+      xml = "<AssetGroupSaveRequest session-id='#{connection.session_id}'>"
       xml << to_xml
       xml << '</AssetGroupSaveRequest>'
-      response = connection.execute(xml)
-      if response.success
-        @id = response.attributes['group-id'].to_i if @id < 0
-      end
+      res = connection.execute(xml)
+      @id = res.attributes['group-id'].to_i if res.success and @id < 1
     end
 
     # Get an XML representation of the group that is valid for a save request.
@@ -87,12 +83,12 @@ module Nexpose
     # @return [String] XML representation of the asset group.
     #
     def to_xml
-      xml = %Q(<AssetGroup id="#{@id}" name="#{@name}")
-      xml << %Q( description="#{@description}") if @description
+      xml = %(<AssetGroup id="#{@id}" name="#{@name}")
+      xml << %( description="#{@description}") if @description
       xml << '>'
       xml << '<Devices>'
       @devices.each do |device|
-        xml << %Q(<device id="#{device.id}"/>)
+        xml << %(<device id="#{device.id}"/>)
       end
       xml << '</Devices>'
       xml << '</AssetGroup>'
@@ -100,45 +96,45 @@ module Nexpose
 
     # Launch ad hoc scans against each group of assets per site.
     #
-    # @param [Connection] connection Connection to console where asset group is configured.
-    # @return [Array[Hash[Fixnum, Fixnum]]] Array of scan ID and engine ID
-    #   pairs for each scan launched.
+    # @param [Connection] connection Connection to console where asset group
+    #   is configured.
+    # @return [Hash] Hash of site ID to Scan launch information for each scan.
     #
     def rescan_assets(connection)
-      sites_ids = @devices.collect { |d| d.site_id }.uniq
-      scans = []
+      sites_ids = @devices.map { |d| d.site_id }.uniq
+      scans = {}
       sites_ids.each do |id|
-        dev_ids = @devices.select { |d| d.site_id == id }.map { |d| d.id }
-        scans << connection.site_device_scan_start(id, dev_ids).merge(:site_id => id)
+        to_scan = @devices.select { |d| d.site_id == id }
+        scans[id] = connection.scan_devices(to_scan)
       end
       scans
     end
 
     # Load an existing configuration from a Nexpose instance.
     #
-    # @param [Connection] connection Connection to console where asset group is configured.
+    # @param [Connection] connection Connection to console where asset group
+    #   is configured.
     # @param [Fixnum] id Asset group ID of an existing group.
-    # @return [AssetGroup] Asset group configuration loaded from a Nexpose console.
+    # @return [AssetGroup] Asset group configuration loaded from a Nexpose
+    #   console.
     #
     def self.load(connection, id)
-      r = APIRequest.execute(connection.url,
-                             %Q(<AssetGroupConfigRequest session-id="#{connection.session_id}" group-id="#{id}"/>))
+      xml = %(<AssetGroupConfigRequest session-id="#{connection.session_id}" group-id="#{id}"/>)
+      r = APIRequest.execute(connection.url, xml)
       parse(r.res)
     end
 
-    alias_method :get, :load
-
     def self.parse(xml)
       return nil unless xml
 
       group = REXML::XPath.first(xml, 'AssetGroupConfigResponse/AssetGroup')
-      asset_group = new(group.attributes['name'].to_s,
-                        group.attributes['description'].to_s,
+      asset_group = new(group.attributes['name'],
+                        group.attributes['description'],
                         group.attributes['id'].to_i,
                         group.attributes['riskscore'].to_f)
       group.elements.each('Devices/device') do |dev|
         asset_group.devices << Device.new(dev.attributes['id'].to_i,
-                                          dev.attributes['address'].to_s,
+                                          dev.attributes['address'],
                                           dev.attributes['site-id'].to_i,
                                           dev.attributes['riskfactor'].to_f,
                                           dev.attributes['riskscore'].to_f)

data/lib/nexpose/manage.rb

@@ -7,6 +7,7 @@ module Nexpose
     # supplied parameter. Console commands are documented in the
     # administrator's guide. If you use a command that is not listed in the
     # administrator's guide, the application will return the XMLResponse.
+    #
     def console_command(cmd_string)
       xml = make_xml('ConsoleCommandRequest', {})
       cmd = REXML::Element.new('Command')
@@ -26,6 +27,7 @@ module Nexpose
     # Obtain system data, such as total RAM, free RAM, total disk space,
     # free disk space, CPU speed, number of CPU cores, and other vital
     # information.
+    #
     def system_information
       r = execute(make_xml('SystemInformationRequest', {}))
 
@@ -42,6 +44,7 @@ module Nexpose
 
     # Induce the application to retrieve required updates and restart
     # if necessary.
+    #
     def start_update
       execute(make_xml('StartUpdateRequest', {})).success
     end
@@ -52,6 +55,7 @@ module Nexpose
     # shuts down as part of the restart process, it terminates any active
     # connections. Therefore, the application cannot issue a response when it
     # restarts.
+    #
     def restart
       execute(make_xml('RestartRequest', {})).success
     end

data/lib/nexpose/pool.rb

@@ -0,0 +1,142 @@
+module Nexpose
+  module NexposeAPI
+    include XMLUtils
+
+    # Retrieve a list of all Scan Engine Pools managed by the Security Console.
+    #
+    # @return [Array[EnginePoolSummary]] Array of EnginePoolSummary objects
+    #   associated with each engine associated with this security console.
+    #
+    def list_engine_pools
+      response = execute(make_xml('EnginePoolListingRequest'), '1.2')
+      arr = []
+      if response.success
+        response.res.elements.each('EnginePoolListingResponse/EnginePoolSummary') do |pool|
+          arr << EnginePoolSummary.new(pool.attributes['id'],
+                                       pool.attributes['name'],
+                                       pool.attributes['scope'])
+        end
+      end
+      arr
+    end
+
+    alias_method :engine_pools, :list_engine_pools
+  end
+
+  # A summary of an engine pool.
+  #
+  class EnginePoolSummary
+
+    # Unique identifier of the engine pool.
+    attr_reader :id
+    # Name of the engine pool.
+    attr_reader :name
+    # Whether the engine pool has global or silo scope.
+    attr_reader :scope
+
+    def initialize(id, name, scope = 'silo')
+      @id = id
+      @name = name
+      @scope = scope
+    end
+  end
+
+  # Engine pool configuration object.
+  #
+  class EnginePool
+
+    # Unique identifier of the engine pool.
+    attr_accessor :id
+    # Name of the engine pool.
+    attr_accessor :name
+    # Whether the engine pool has global or silo scope.
+    attr_accessor :scope
+    # Array containing (EngineSummary*) for each engine assigned to the pool.
+    attr_accessor :engines
+
+    def initialize(name, scope = 'silo', id = -1)
+      @name, @scope, @id = name, scope, id.to_i
+      @engines = []
+    end
+
+    # Add an engine to the pool by name (not ID).
+    #
+    # EngineSummary objects should just be appended to the pool directly,
+    #   e.g., pool.engines << nsc.engines.find { |e| e.name == 'Cleveland' }
+    #
+    # @param [String] engine_name Name used to identify a paired scan engine.
+    #
+    def add(engine_name)
+      @engines << EngineSummary.new(-1, engine_name, nil, 40814, nil)
+    end
+
+    # Returns detailed information about a single engine pool.
+    #
+    # @param [Connection] connection Connection to console where site exists.
+    # @param [String] name The name of the engine pool.
+    # @param [String] silo The silo of the engine pool.
+    # @return [EnginePool] Engine pool configuration object.
+    #
+    def self.load(connection, name, scope = 'silo')
+      xml = %(<EnginePoolDetailsRequest session-id="#{connection.session_id}">)
+      xml << %(<EnginePool name="#{name}" scope="#{scope}"/>)
+      xml << '</EnginePoolDetailsRequest>'
+
+      r = connection.execute(xml, '1.2')
+      if r.success
+        r.res.elements.each('EnginePoolDetailsResponse/EnginePool') do |pool|
+          config = EnginePool.new(pool.attributes['name'],
+                                  pool.attributes['scope'],
+                                  pool.attributes['id'].to_i)
+          r.res.elements.each('EnginePoolDetailsResponse/EnginePool/EngineSummary') do |summary|
+            config.engines << EngineSummary.new(summary.attributes['id'].to_i,
+                                                summary.attributes['name'],
+                                                summary.attributes['address'],
+                                                summary.attributes['port'].to_i,
+                                                summary.attributes['status'],
+                                                summary.attributes['scope'])
+          end
+          return config
+        end
+      end
+      nil
+    end
+
+    # Save an engine pool to a security console.
+    #
+    # @param [Connection] connection Connection to console where site exists.
+    #
+    def save(connection)
+      request = @id > 0 ? 'EnginePoolUpdateRequest' : 'EnginePoolCreateRequest'
+      xml = %(<#{request} session-id="#{connection.session_id}">)
+      xml << '<EnginePool'
+      xml << %( id="#{@id}") if @id > 0
+      xml << %( name="#{@name}" scope="#{@scope}">)
+      @engines.each do |engine|
+        xml << %(<Engine name="#{engine.name}" />)
+      end
+      xml << '</EnginePool>'
+      xml << %(</#{request}>)
+
+      r = connection.execute(xml, '1.2')
+      if r.success
+        r.res.elements.each(request.gsub('Request', 'Response')) do |v|
+          return @id = v.attributes['id'].to_i
+        end
+      end
+    end
+
+    # Deletes an engine pool
+    #
+    # @param [Connection] connection Connection to console where site exists.
+    #
+    def delete(connection)
+      xml = %(<EnginePoolDeleteRequest session-id="#{connection.session_id}">)
+      xml << %(<EnginePool name="#{@name}" scope="#{@scope}" />)
+      xml << '</EnginePoolDeleteRequest>'
+
+      r = connection.execute(xml, '1.2')
+      r.success
+    end
+  end
+end

data/lib/nexpose/report.rb

@@ -6,6 +6,24 @@ module Nexpose
   module NexposeAPI
     include XMLUtils
 
+    # Provide a listing of all report definitions the user can access on the
+    # Security Console.
+    #
+    # @return [Array[ReportConfigSummary]] List of current report configuration.
+    #
+    def list_reports
+      r = execute(make_xml('ReportListingRequest'))
+      reports = []
+      if r.success
+        r.res.elements.each('//ReportConfigSummary') do |report|
+          reports << ReportConfigSummary.parse(report)
+        end
+      end
+      reports
+    end
+
+    alias_method :reports, :list_reports
+
     # Generate a new report using the specified report definition.
     def generate_report(report_id, wait = false)
       xml = make_xml('ReportGenerateRequest', { 'report-id' => report_id })
@@ -43,65 +61,31 @@ module Nexpose
       history.sort { |a, b| b.generated_on <=> a.generated_on }.first
     end
 
-    # Delete a previously generated report definition.
-    # Also deletes any reports generated from that configuration.
-    def delete_report_config(report_config_id)
-      xml = make_xml('ReportDeleteRequest', { 'reportcfg-id' => report_config_id })
-      execute(xml).success
-    end
-
     # Delete a previously generated report.
+    #
+    # @param [Fixnum] report_id ID of individual report to delete.
+    #
     def delete_report(report_id)
       xml = make_xml('ReportDeleteRequest', { 'report-id' => report_id })
       execute(xml).success
     end
 
-    # Provide a list of all report templates the user can access on the
-    # Security Console.
-    def report_template_listing
-      r = execute(make_xml('ReportTemplateListingRequest', {}))
-      templates = []
-      if r.success
-        r.res.elements.each('//ReportTemplateSummary') do |template|
-          templates << ReportTemplateSummary.parse(template)
-        end
-      end
-      templates
-    end
-
-    alias_method :report_templates, :report_template_listing
-
-    # Retrieve the configuration for a report template.
-    def get_report_template(template_id)
-      xml = make_xml('ReportTemplateConfigRequest', { 'template-id' => template_id })
-      ReportTemplate.parse(execute(xml))
-    end
-
-    # Provide a listing of all report definitions the user can access on the
-    # Security Console.
-    def report_listing
-      r = execute(make_xml('ReportListingRequest'))
-      reports = []
-      if r.success
-        r.res.elements.each('//ReportConfigSummary') do |report|
-          reports << ReportConfigSummary.parse(report)
-        end
-      end
-      reports
-    end
-
-    alias_method :reports, :report_listing
-
-    # Retrieve the configuration for a report definition.
-    def get_report_config(report_config_id)
-      xml = make_xml('ReportConfigRequest', { 'reportcfg-id' => report_config_id })
-      ReportConfig.parse(execute(xml))
+    # Delete a previously generated report definition.
+    # Also deletes any reports generated from that configuration.
+    #
+    # @param [Fixnum] report_config_id ID of the report configuration to remove.
+    #
+    def delete_report_config(report_config_id)
+      xml = make_xml('ReportDeleteRequest', { 'reportcfg-id' => report_config_id })
+      execute(xml).success
     end
   end
 
   # Data object for report configuration information.
   # Not meant for use in creating new configurations.
+  #
   class ReportConfigSummary
+
     # The report definition (config) ID.
     attr_reader :config_id
     # The ID of the report template.
@@ -137,8 +121,10 @@ module Nexpose
   end
 
   # Summary of a single report.
+  #
   class ReportSummary
-    # The id of the generated report.
+
+    # The ID of the generated report.
     attr_reader :id
     # The report definition (configuration) ID.
     attr_reader :config_id
@@ -193,6 +179,7 @@ module Nexpose
     attr_accessor :format
     attr_accessor :owner
     attr_accessor :time_zone
+    attr_accessor :language
 
     # Array of filters associated with this report.
     attr_accessor :filters
@@ -220,16 +207,17 @@ module Nexpose
     end
 
     def to_xml
-      xml = %Q(<AdhocReportConfig format='#{@format}' template-id='#{@template_id}')
-      xml << %Q( owner='#{@owner}') if @owner
-      xml << %Q( timezone='#{@time_zone}') if @time_zone
+      xml = %(<AdhocReportConfig format='#{@format}' template-id='#{@template_id}')
+      xml << %( owner='#{@owner}') if @owner
+      xml << %( timezone='#{@time_zone}') if @time_zone
+      xml << %( language='#{@language}') if @language
       xml << '>'
 
       xml << '<Filters>'
       @filters.each { |filter| xml << filter.to_xml }
       xml << '</Filters>'
 
-      xml << %Q(<Baseline compareTo='#{@baseline}' />) if @baseline
+      xml << %(<Baseline compareTo='#{@baseline}' />) if @baseline
 
       xml << '</AdhocReportConfig>'
     end
@@ -244,7 +232,7 @@ module Nexpose
     # @return Report in text format except for PDF, which returns binary data.
     #
     def generate(connection)
-      xml = %Q{<ReportAdhocGenerateRequest session-id='#{connection.session_id}'>}
+      xml = %(<ReportAdhocGenerateRequest session-id='#{connection.session_id}'>)
       xml << to_xml
       xml << '</ReportAdhocGenerateRequest>'
       response = connection.execute(xml)
@@ -309,7 +297,8 @@ module Nexpose
 
     # Retrieve the configuration for an existing report definition.
     def self.load(connection, report_config_id)
-      connection.get_report_config(report_config_id)
+      xml = %(<ReportConfigRequest session-id='#{connection.session_id}' reportcfg-id='#{report_config_id}'/>)
+      ReportConfig.parse(connection.execute(xml))
     end
 
     alias_method :get, :load
@@ -319,7 +308,7 @@ module Nexpose
     #
     # Returns the new configuration.
     def self.build(connection, site_id, site_name, type, format, generate_now = false)
-      name = %Q{#{site_name} #{type} report in #{format}}
+      name = %(#{site_name} #{type} report in #{format})
       config = ReportConfig.new(name, type, format)
       config.frequency = Frequency.new(true, false)
       config.filters << Filter.new('site', site_id)
@@ -329,7 +318,7 @@ module Nexpose
 
     # Save the configuration of this report definition.
     def save(connection, generate_now = false)
-      xml = %Q{<ReportSaveRequest session-id='#{connection.session_id}' generate-now='#{generate_now ? 1 : 0}'>}
+      xml = %(<ReportSaveRequest session-id='#{connection.session_id}' generate-now='#{generate_now ? 1 : 0}'>)
       xml << to_xml
       xml << '</ReportSaveRequest>'
       response = connection.execute(xml)
@@ -351,18 +340,22 @@ module Nexpose
     end
 
     def to_xml
-      xml = %Q{<ReportConfig format='#{@format}' id='#{@id}' name='#{@name}' owner='#{@owner}' template-id='#{@template_id}' timezone='#{@time_zone}'>}
-      xml << %Q{<description>#{@description}</description>} if @description
+      xml = %(<ReportConfig format='#{@format}' id='#{@id}' name='#{@name}' template-id='#{@template_id}')
+      xml << %( owner='#{@owner}') if @owner
+      xml << %( timezone='#{@time_zone}') if @time_zone
+      xml << %( language='#{@language}') if @language
+      xml << '>'
+      xml << %(<description>#{@description}</description>) if @description
 
       xml << '<Filters>'
       @filters.each { |filter| xml << filter.to_xml }
       xml << '</Filters>'
 
       xml << '<Users>'
-      @users.each { |user| xml << %Q{<user id='#{user}' />} }
+      @users.each { |user| xml << %(<user id='#{user}' />) }
       xml << '</Users>'
 
-      xml << %Q{<Baseline compareTo='#{@baseline}' />} if @baseline
+      xml << %(<Baseline compareTo='#{@baseline}' />) if @baseline
       xml << @frequency.to_xml if @frequency
       xml << @delivery.to_xml if @delivery
       xml << @db_export.to_xml if @db_export
@@ -412,7 +405,9 @@ module Nexpose
   # or raw_xml. If the vuln-status filter is not included in the configuration,
   # all the vulnerability test results (including invulnerable instances) are
   # exported by default in csv and raw_xml reports.
+  #
   class Filter
+
     # The ID of the specific site, group, device, or scan.
     # For scan, this can also be "last" for the most recently run scan.
     # For vuln-status, the ID can have one of the following values:
@@ -430,7 +425,7 @@ module Nexpose
     end
 
     def to_xml
-      %Q{<filter id='#{@id}' type='#{@type}' />}
+      %(<filter id='#{@id}' type='#{@type}' />)
     end
 
     def self.parse(xml)
@@ -443,7 +438,9 @@ module Nexpose
   end
 
   # Data object associated with when a report is generated.
+  #
   class Frequency
+
     # Will the report be generated after a scan completes (true),
     # or is it ad hoc/scheduled (false).
     attr_accessor :after_scan
@@ -459,7 +456,7 @@ module Nexpose
     end
 
     def to_xml
-      xml = %Q{<Generate after-scan='#{@after_scan ? 1 : 0}' schedule='#{@scheduled ? 1 : 0}'>}
+      xml = %(<Generate after-scan='#{@after_scan ? 1 : 0}' schedule='#{@scheduled ? 1 : 0}'>)
       xml << @schedule.to_xml if @schedule
       xml << '</Generate>'
     end
@@ -483,7 +480,9 @@ module Nexpose
   end
 
   # Data object for configuration of where a report is stored or delivered.
+  #
   class Delivery
+
     # Whether to store report on server.
     attr_accessor :store_on_server
     # Directory location to store report in (for non-default storage).
@@ -499,8 +498,8 @@ module Nexpose
 
     def to_xml
       xml = '<Delivery>'
-      xml << %Q{<Storage storeOnServer='#{@store_on_server ? 1 : 0}'>}
-      xml << %Q{<location>#{@location}</location>} if @location
+      xml << %(<Storage storeOnServer='#{@store_on_server ? 1 : 0}'>)
+      xml << %(<location>#{@location}</location>) if @location
       xml << '</Storage>'
       xml << @email.to_xml if @email
       xml << '</Delivery>'
@@ -526,7 +525,9 @@ module Nexpose
   end
 
   # Configuration structure for database exporting of reports.
+  #
   class DBExport
+
     # The DB type to export to.
     attr_accessor :type
     # Credentials needed to export to the specified database.
@@ -540,10 +541,10 @@ module Nexpose
     end
 
     def to_xml
-      xml = %Q{<DBExport type='#{@type}'>}
+      xml = %(<DBExport type='#{@type}'>)
       xml << @credentials.to_xml if @credentials
       @parameters.each_pair do |name, value|
-        xml << %Q{<param name='#{name}'>#{value}</param>}
+        xml << %(<param name='#{name}'>#{value}</param>)
       end
       xml << '</DBExport>'
     end
@@ -566,7 +567,9 @@ module Nexpose
   # The user_id, password and realm attributes should ONLY be used
   # if a security blob cannot be generated and the data is being
   # transmitted/stored using external encryption (e.g., HTTPS).
+  #
   class ExportCredential
+
     # Security blob for exporting to a database.
     attr_accessor :credential
     attr_accessor :user_id
@@ -580,9 +583,9 @@ module Nexpose
 
     def to_xml
       xml = '<credentials'
-      xml << %Q{ userid='#{@user_id}'} if @user_id
-      xml << %Q{ password='#{@password}'} if @password
-      xml << %Q{ realm='#{@realm}'} if @realm
+      xml << %( userid='#{@user_id}') if @user_id
+      xml << %( password='#{@password}') if @password
+      xml << %( realm='#{@realm}') if @realm
       xml << '>'
       xml << @credential if @credential
       xml << '</credentials>'
@@ -600,213 +603,4 @@ module Nexpose
       nil
     end
   end
-
-  # Data object for report template summary information.
-  # Not meant for use in creating new templates.
-  class ReportTemplateSummary
-    # The ID of the report template.
-    attr_reader :id
-    # The name of the report template.
-    attr_reader :name
-    # One of: data|document. With a data template, you can export
-    # comma-separated value (CSV) files with vulnerability-based data.
-    # With a document template, you can create PDF, RTF, HTML, or XML reports
-    # with asset-based information.
-    attr_reader :type
-    # The visibility (scope) of the report template. One of: global|silo
-    attr_reader :scope
-    # Whether the report template is built-in, and therefore cannot be modified.
-    attr_reader :built_in
-    # Description of the report template.
-    attr_reader :description
-
-    def initialize(id, name, type, scope, built_in, description)
-      @id = id
-      @name = name
-      @type = type
-      @scope = scope
-      @built_in = built_in
-      @description = description
-    end
-
-    def self.parse(xml)
-      description = nil
-      xml.elements.each('description') { |desc| description = desc.text }
-      ReportTemplateSummary.new(xml.attributes['id'],
-                                xml.attributes['name'],
-                                xml.attributes['type'],
-                                xml.attributes['scope'],
-                                xml.attributes['builtin'] == '1',
-                                description)
-    end
-  end
-
-  # Definition object for a report template.
-  class ReportTemplate
-    # The ID of the report template.
-    attr_accessor :id
-    # The name of the report template.
-    attr_accessor :name
-    # With a data template, you can export comma-separated value (CSV) files
-    # with vulnerability-based data. With a document template, you can create
-    # PDF, RTF, HTML, or XML reports with asset-based information. When you
-    # retrieve a report template, the type will always be visible even though
-    # type is implied. When ReportTemplate is sent as a request, and the type
-    # attribute is not provided, the type attribute defaults to document,
-    # allowing for backward compatibility with existing API clients.
-    attr_accessor :type
-    # The visibility (scope) of the report template.
-    # One of: global|silo
-    attr_accessor :scope
-    # The report template is built-in, and cannot be modified.
-    attr_accessor :built_in
-    # Description of this report template.
-    attr_accessor :description
-
-    # Array of report sections.
-    attr_accessor :sections
-    # Map of report properties.
-    attr_accessor :properties
-    # Array of report attributes, in the order they will be present in a report.
-    attr_accessor :attributes
-    # Display asset names with IPs.
-    attr_accessor :show_device_names
-
-    def initialize(name, type = 'document', id = -1, scope = 'silo', built_in = false)
-      @name = name
-      @type = type
-      @id = id
-      @scope = scope
-      @built_in = built_in
-
-      @sections = []
-      @properties = {}
-      @attributes = []
-      @show_device_names = false
-    end
-
-    # Save the configuration for a report template.
-    def save(connection)
-      xml = %Q{<ReportTemplateSaveRequest session-id='#{connection.session_id}' scope='#{@scope}'>}
-      xml << to_xml
-      xml << '</ReportTemplateSaveRequest>'
-      response = connection.execute(xml)
-      if response.success
-        @id = response.attributes['template-id']
-      end
-    end
-
-    def delete(connection)
-      xml = %Q{<ReportTemplateDeleteRequest session-id='#{connection.session_id}' template-id='#{@id}'>}
-      xml << '</ReportTemplateDeleteRequest>'
-      response = connection.execute(xml)
-      if response.success
-        @id = response.attributes['template-id']
-      end
-    end
-
-    # Retrieve the configuration for a report template.
-    def self.load(connection, template_id)
-      connection.get_report_template(template_id)
-    end
-
-    alias_method :get, :load
-
-    include Sanitize
-
-    def to_xml
-      xml = %Q{<ReportTemplate id='#{@id}' name='#{@name}' type='#{@type}'}
-      xml << %Q{ scope='#{@scope}'} if @scope
-      xml << %Q{ builtin='#{@built_in}'} if @built_in
-      xml << '>'
-      xml << %Q{<description>#{@description}</description>} if @description
-
-      unless @attributes.empty?
-        xml << '<ReportAttributes>'
-        @attributes.each do |attr|
-          xml << %Q(<ReportAttribute name='#{attr}'/>)
-        end
-        xml << '</ReportAttributes>'
-      end
-
-      unless @sections.empty?
-        xml << '<ReportSections>'
-        properties.each_pair do |name, value|
-          xml << %Q{<property name='#{name}'>#{replace_entities(value)}</property>}
-        end
-        @sections.each { |section| xml << section.to_xml }
-        xml << '</ReportSections>'
-      end
-
-      xml << %Q{<Settings><showDeviceNames enabled='#{@show_device_names ? 1 : 0}' /></Settings>}
-      xml << '</ReportTemplate>'
-    end
-
-    def self.parse(xml)
-      xml.res.elements.each('//ReportTemplate') do |tmp|
-        template = ReportTemplate.new(tmp.attributes['name'],
-                                      tmp.attributes['type'],
-                                      tmp.attributes['id'],
-                                      tmp.attributes['scope'] || 'silo',
-                                      tmp.attributes['builtin'])
-        tmp.elements.each('//description') do |desc|
-          template.description = desc.text
-        end
-
-        tmp.elements.each('//ReportAttributes/ReportAttribute') do |attr|
-          template.attributes << attr.attributes['name']
-        end
-
-        tmp.elements.each('//ReportSections/property') do |property|
-          template.properties[property.attributes['name']] = property.text
-        end
-
-        tmp.elements.each('//ReportSection') do |section|
-          template.sections << Section.parse(section)
-        end
-
-        tmp.elements.each('//showDeviceNames') do |show|
-          template.show_device_names = show.attributes['enabled'] == '1'
-        end
-
-        return template
-      end
-      nil
-    end
-  end
-
-  # Section specific content to include in a report template.
-  class Section
-    # Name of the report section.
-    attr_accessor :name
-    # Map of properties specific to the report section.
-    attr_accessor :properties
-
-    def initialize(name)
-      @name = name
-      @properties = {}
-    end
-
-    include Sanitize
-
-    def to_xml
-      xml = %Q{<ReportSection name='#{@name}'>}
-      properties.each_pair do |name, value|
-        xml << %Q{<property name='#{name}'>#{replace_entities(value)}</property>}
-      end
-      xml << '</ReportSection>'
-    end
-
-    def self.parse(xml)
-      name = xml.attributes['name']
-      xml.elements.each("//ReportSection[@name='#{name}']") do |elem|
-        section = Section.new(name)
-        elem.elements.each("//ReportSection[@name='#{name}']/property") do |property|
-          section.properties[property.attributes['name']] = property.text
-        end
-        return section
-      end
-      nil
-    end
-  end
 end