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.



1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
 
# File 'lib/nexpose.rb', line 1862

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



1850
1851
1852
 
# File 'lib/nexpose.rb', line 1850

def configID
  @configID
end

#configVersion ⇒ Object (readonly)

The configuration version (default is 2)



1856
1857
1858
 
# File 'lib/nexpose.rb', line 1856

def configVersion
  @configVersion
end

#name ⇒ Object (readonly)

The name of the scan template



1852
1853
1854
 
# File 'lib/nexpose.rb', line 1852

def name
  @name
end

#scanTriggers ⇒ Object (readonly)

Array of (ScanTrigger)*



1860
1861
1862
 
# File 'lib/nexpose.rb', line 1860

def scanTriggers
  @scanTriggers
end

#schedules ⇒ Object (readonly)

Array of (Schedule)*



1858
1859
1860
 
# File 'lib/nexpose.rb', line 1858

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



1854
1855
1856
 
# File 'lib/nexpose.rb', line 1854

def templateID
  @templateID
end

Instance Method Details

#_set_configID(configID) ⇒ Object 



1883
1884
1885
 
# File 'lib/nexpose.rb', line 1883

def _set_configID(configID)
	@configID = configID
end

#_set_name(name) ⇒ Object 



1887
1888
1889
 
# File 'lib/nexpose.rb', line 1887

def _set_name(name)
	@name = name
end

#addScanTrigger(scanTrigger) ⇒ Object

Adds a new ScanTrigger to the scanTriggers array



1879
1880
1881
 
# File 'lib/nexpose.rb', line 1879

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

#addSchedule(schedule) ⇒ Object

Adds a new Schedule for this ScanConfig



1874
1875
1876
 
# File 'lib/nexpose.rb', line 1874

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