Class: Nexpose::SiteListing

Inherits:
Object
  • Object
show all
Defined in:
lib/nexpose.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)



925
926
927
928
929
930
931
932
933
934
935
936
937
 
# File 'lib/nexpose.rb', line 925

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



917
918
919
 
# File 'lib/nexpose.rb', line 917

def connection
  @connection
end

#error ⇒ Object (readonly)

true if an error condition exists; false otherwise



909
910
911
 
# File 'lib/nexpose.rb', line 909

def error
  @error
end

#error_msg ⇒ Object (readonly)

Error message string



911
912
913
 
# File 'lib/nexpose.rb', line 911

def error_msg
  @error_msg
end

#request_xml ⇒ Object (readonly)

The last XML request sent by this object



913
914
915
 
# File 'lib/nexpose.rb', line 913

def request_xml
  @request_xml
end

#response_xml ⇒ Object (readonly)

The last XML response received by this object



915
916
917
 
# File 'lib/nexpose.rb', line 915

def response_xml
  @response_xml
end

#site_count ⇒ Object (readonly)

The number of sites



921
922
923
 
# File 'lib/nexpose.rb', line 921

def site_count
  @site_count
end

#sites ⇒ Object (readonly)

Array containing SiteSummary objects for each site in the connection



919
920
921
 
# File 'lib/nexpose.rb', line 919

def sites
  @sites
end

Instance Method Details

#parse(r) ⇒ Object 



939
940
941
942
943
944
945
946
947
948
949
950
 
# File 'lib/nexpose.rb', line 939

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