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.



1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
 
# File 'lib/nexpose.rb', line 1385

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



1373
1374
1375
 
# File 'lib/nexpose.rb', line 1373

def configID
  @configID
end

#configVersion ⇒ Object (readonly)

The configuration version (default is 2)



1379
1380
1381
 
# File 'lib/nexpose.rb', line 1379

def configVersion
  @configVersion
end

#name ⇒ Object (readonly)

The name of the scan template



1375
1376
1377
 
# File 'lib/nexpose.rb', line 1375

def name
  @name
end

#scanTriggers ⇒ Object (readonly)

Array of (ScanTrigger)*



1383
1384
1385
 
# File 'lib/nexpose.rb', line 1383

def scanTriggers
  @scanTriggers
end

#schedules ⇒ Object (readonly)

Array of (Schedule)*



1381
1382
1383
 
# File 'lib/nexpose.rb', line 1381

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



1377
1378
1379
 
# File 'lib/nexpose.rb', line 1377

def templateID
  @templateID
end

Instance Method Details

#_set_configID(configID) ⇒ Object 



1406
1407
1408
 
# File 'lib/nexpose.rb', line 1406

def _set_configID(configID)
	@configID = configID
end

#_set_name(name) ⇒ Object 



1410
1411
1412
 
# File 'lib/nexpose.rb', line 1410

def _set_name(name)
	@name = name
end

#addScanTrigger(scanTrigger) ⇒ Object

Adds a new ScanTrigger to the scanTriggers array



1402
1403
1404
 
# File 'lib/nexpose.rb', line 1402

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

#addSchedule(schedule) ⇒ Object

Adds a new Schedule for this ScanConfig



1397
1398
1399
 
# File 'lib/nexpose.rb', line 1397

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