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.



1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
 
# File 'lib/nexpose.rb', line 1511

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



1499
1500
1501
 
# File 'lib/nexpose.rb', line 1499

def configID
  @configID
end

#configVersion ⇒ Object (readonly)

The configuration version (default is 2)



1505
1506
1507
 
# File 'lib/nexpose.rb', line 1505

def configVersion
  @configVersion
end

#name ⇒ Object (readonly)

The name of the scan template



1501
1502
1503
 
# File 'lib/nexpose.rb', line 1501

def name
  @name
end

#scanTriggers ⇒ Object (readonly)

Array of (ScanTrigger)*



1509
1510
1511
 
# File 'lib/nexpose.rb', line 1509

def scanTriggers
  @scanTriggers
end

#schedules ⇒ Object (readonly)

Array of (Schedule)*



1507
1508
1509
 
# File 'lib/nexpose.rb', line 1507

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



1503
1504
1505
 
# File 'lib/nexpose.rb', line 1503

def templateID
  @templateID
end

Instance Method Details

#_set_configID(configID) ⇒ Object 



1532
1533
1534
 
# File 'lib/nexpose.rb', line 1532

def _set_configID(configID)
	@configID = configID
end

#_set_name(name) ⇒ Object 



1536
1537
1538
 
# File 'lib/nexpose.rb', line 1536

def _set_name(name)
	@name = name
end

#addScanTrigger(scanTrigger) ⇒ Object

Adds a new ScanTrigger to the scanTriggers array



1528
1529
1530
 
# File 'lib/nexpose.rb', line 1528

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

#addSchedule(schedule) ⇒ Object

Adds a new Schedule for this ScanConfig



1523
1524
1525
 
# File 'lib/nexpose.rb', line 1523

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