Class: Nexpose::ScanConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/nexpose.rb

Overview

TODO add engineID

Description

Object that represents the scanning configuration for a Site.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configID, name, templateID, configVersion = 2) ⇒ ScanConfig

Returns a new instance of ScanConfig.



1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
 
# File 'lib/nexpose.rb', line 1733

def initialize(configID, name, templateID, configVersion = 2)

	@configID = configID
	@name = name
	@templateID = templateID
	@configVersion = configVersion
	@schedules = Array.new()
	@scanTriggers = Array.new()

end

Instance Attribute Details

#configID ⇒ Object (readonly)

A unique ID for this scan configuration



1721
1722
1723
 
# File 'lib/nexpose.rb', line 1721

def configID
  @configID
end

#configVersion ⇒ Object (readonly)

The configuration version (default is 2)



1727
1728
1729
 
# File 'lib/nexpose.rb', line 1727

def configVersion
  @configVersion
end

#name ⇒ Object (readonly)

The name of the scan template



1723
1724
1725
 
# File 'lib/nexpose.rb', line 1723

def name
  @name
end

#scanTriggers ⇒ Object (readonly)

Array of (ScanTrigger)*



1731
1732
1733
 
# File 'lib/nexpose.rb', line 1731

def scanTriggers
  @scanTriggers
end

#schedules ⇒ Object (readonly)

Array of (Schedule)*



1729
1730
1731
 
# File 'lib/nexpose.rb', line 1729

def schedules
  @schedules
end

#templateID ⇒ Object (readonly)

The ID of the scan template used full-audit, exhaustive-audit, web-audit, dos-audit, internet-audit, network-audit



1725
1726
1727
 
# File 'lib/nexpose.rb', line 1725

def templateID
  @templateID
end

Instance Method Details

#_set_configID(configID) ⇒ Object 



1754
1755
1756
 
# File 'lib/nexpose.rb', line 1754

def _set_configID(configID)
	@configID = configID
end

#_set_name(name) ⇒ Object 



1758
1759
1760
 
# File 'lib/nexpose.rb', line 1758

def _set_name(name)
	@name = name
end

#addScanTrigger(scanTrigger) ⇒ Object

Adds a new ScanTrigger to the scanTriggers array



1750
1751
1752
 
# File 'lib/nexpose.rb', line 1750

def addScanTrigger(scanTrigger)
	@scanTriggers.push(scanTrigger)
end

#addSchedule(schedule) ⇒ Object

Adds a new Schedule for this ScanConfig



1745
1746
1747
 
# File 'lib/nexpose.rb', line 1745

def addSchedule(schedule)
	@schedules.push(schedule)
end