Class: Nexpose::SiteListing

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

Overview

Description

Object that represents a listing of all of the sites available on an NSC.

Example

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

# Get Site Listing
sitelisting = SiteListing.new(nsc)

# Enumerate through all of the SiteSummaries
sitelisting.sites.each do |sitesummary|
    # Do some operation on each site
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ SiteListing

Constructor SiteListing (connection)



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/nexpose/site.rb', line 428

def initialize(connection)
  @sites = []

  @connection = connection

  r = @connection.execute('<SiteListingRequest session-id="' + @connection.session_id.to_s + '"/>')

  if (r.success)
    parse(r.res)
  else
    raise APIError.new(r, "Failed to get site listing")
  end
end

Instance Attribute Details

#connection ⇒ Object (readonly)

The NSC Connection associated with this object



420
421
422
 
# File 'lib/nexpose/site.rb', line 420

def connection
  @connection
end

#error ⇒ Object (readonly)

true if an error condition exists; false otherwise



412
413
414
 
# File 'lib/nexpose/site.rb', line 412

def error
  @error
end

#error_msg ⇒ Object (readonly)

Error message string



414
415
416
 
# File 'lib/nexpose/site.rb', line 414

def error_msg
  @error_msg
end

#request_xml ⇒ Object (readonly)

The last XML request sent by this object



416
417
418
 
# File 'lib/nexpose/site.rb', line 416

def request_xml
  @request_xml
end

#response_xml ⇒ Object (readonly)

The last XML response received by this object



418
419
420
 
# File 'lib/nexpose/site.rb', line 418

def response_xml
  @response_xml
end

#site_count ⇒ Object (readonly)

The number of sites



424
425
426
 
# File 'lib/nexpose/site.rb', line 424

def site_count
  @site_count
end

#sites ⇒ Object (readonly)

Array containing SiteSummary objects for each site in the connection



422
423
424
 
# File 'lib/nexpose/site.rb', line 422

def sites
  @sites
end

Instance Method Details

#parse(r) ⇒ Object 



442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/nexpose/site.rb', line 442

def parse(r)
  r.elements.each('SiteListingResponse/SiteSummary') do |s|
    site_summary = SiteSummary.new(
      s.attributes['id'].to_s,
      s.attributes['name'].to_s,
      s.attributes['description'].to_s,
      s.attributes['riskfactor'].to_s
    )
    @sites.push(site_summary)
  end
  @site_count = @sites.length
end