Class: Nexpose::EngineSummary

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

Overview

Object representing the current details of a scan engine attached to the security console.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, name, address, port, status, scope = 'silo') ⇒ EngineSummary

Returns a new instance of EngineSummary.



112
113
114
115
116
117
118
119
# File 'lib/nexpose/engine.rb', line 112

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

Instance Attribute Details

#addressObject (readonly)

The hostname or IP address of the engine.



102
103
104
# File 'lib/nexpose/engine.rb', line 102

def address
  @address
end

#idObject (readonly)

A unique ID that identifies this scan engine.



98
99
100
# File 'lib/nexpose/engine.rb', line 98

def id
  @id
end

#nameObject (readonly)

The name of this scan engine.



100
101
102
# File 'lib/nexpose/engine.rb', line 100

def name
  @name
end

#portObject (readonly)

The port there the engine is listening.



104
105
106
# File 'lib/nexpose/engine.rb', line 104

def port
  @port
end

#scopeObject (readonly)

A parameter that specifies whether the engine has a global or silo-specific scope.



110
111
112
# File 'lib/nexpose/engine.rb', line 110

def scope
  @scope
end

#statusObject (readonly)

The engine status. One of: active, pending-auth, incompatible, not-responding, unknown



107
108
109
# File 'lib/nexpose/engine.rb', line 107

def status
  @status
end