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.



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

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.



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

def address
  @address
end

#idObject (readonly)

A unique ID that identifies this scan engine.



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

def id
  @id
end

#nameObject (readonly)

The name of this scan engine.



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

def name
  @name
end

#portObject (readonly)

The port there the engine is listening.



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

def port
  @port
end

#scopeObject (readonly)

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



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

def scope
  @scope
end

#statusObject (readonly)

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



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

def status
  @status
end