Class: Nexpose::EngineSummary

Inherits:

Object

• Object
• Nexpose::EngineSummary

Defined in:

lib/nexpose.rb

Overview

Description

Object that represents the summary of a scan engine.

Examples

# Create a new Nexpose Connection on the default port and Login
nsc = Connection.new("10.1.40.10","nxadmin","password")
nsc.login()

# Get the engine listing for the connection
enginelisting = EngineListing.new(nsc)

# Print out the status of the first scan engine
puts enginelisting.engines[0].status

Instance Attribute Summary

• #address ⇒ Object readonly

  The hostname or IP address of the engine.

• #id ⇒ Object readonly

  A unique ID that identifies this scan engine.

• #name ⇒ Object readonly

  The name of this scan engine.

• #port ⇒ Object readonly

  The port there the engine is listening.

• #status ⇒ Object readonly

  The engine status (active|pending-auth| incompatible|not-responding|unknown).

Instance Method Summary

• #initialize(id, name, address, port, status) ⇒ EngineSummary constructor

  Constructor EngineSummary(id, name, address, port, status).

Constructor Details

#initialize(id, name, address, port, status) ⇒ EngineSummary

Constructor EngineSummary(id, name, address, port, status)

# File 'lib/nexpose.rb', line 1665

def initialize(id, name, address, port, status)
	@id = id
	@name = name
	@address = address
	@port = port
	@status = status
end

Instance Attribute Details

#address ⇒ Object (readonly)

The hostname or IP address of the engine

# File 'lib/nexpose.rb', line 1657

def address
  @address
end

#id ⇒ Object (readonly)

A unique ID that identifies this scan engine

# File 'lib/nexpose.rb', line 1653

def id
  @id
end

#name ⇒ Object (readonly)

The name of this scan engine

# File 'lib/nexpose.rb', line 1655

def name
  @name
end

#port ⇒ Object (readonly)

The port there the engine is listening

# File 'lib/nexpose.rb', line 1659

def port
  @port
end

#status ⇒ Object (readonly)

The engine status (active|pending-auth| incompatible|not-responding|unknown)

# File 'lib/nexpose.rb', line 1661

def status
  @status
end