class Nexpose::ReportTemplateSummary

Data object for report template summary information. Not meant for use in creating new templates.

Attributes

built_in[R]

Whether the report template is built-in, and therefore cannot be modified.

description[R]

Description of the report template.

id[R]

The ID of the report template.

name[R]

The name of the report template.

scope[R]

The visibility (scope) of the report template. One of: global|silo

type[R]

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.

Public Class Methods

new(id, name, type, scope, built_in, description) click to toggle source
# File lib/nexpose/report_template.rb, line 55
def initialize(id, name, type, scope, built_in, description)
  @id          = id
  @name        = name
  @type        = type
  @scope       = scope
  @built_in    = built_in
  @description = description
end
parse(xml) click to toggle source
# File lib/nexpose/report_template.rb, line 68
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

Public Instance Methods

delete(connection) click to toggle source
# File lib/nexpose/report_template.rb, line 64
def delete(connection)
  connection.delete_report_template(@id)
end