Class: Nexpose::SNMPAlert

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

Overview

Description

Object that represents an SNMP Alert.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Sanitize

#replace_entities

Constructor Details

#initialize(name, community, server, enabled = 1) ⇒ SNMPAlert

Returns a new instance of SNMPAlert.



586
587
588
589
590
591
592
593
594
 
# File 'lib/nexpose/site.rb', line 586

def initialize(name, community, server, enabled = 1)
  @type = :snmp
  @name = name
  @community = community
  @server = server
  @enabled = enabled
  # Sets default vuln filter - All Events
  setVulnFilter(VulnFilter.new("50790400", 1))
end

Instance Attribute Details

#community ⇒ Object (readonly)

The community string



578
579
580
 
# File 'lib/nexpose/site.rb', line 578

def community
  @community
end

#enabled ⇒ Object (readonly)

If this alert is enabled or not



576
577
578
 
# File 'lib/nexpose/site.rb', line 576

def enabled
  @enabled
end

#name ⇒ Object (readonly)

A unique name for this alert



574
575
576
 
# File 'lib/nexpose/site.rb', line 574

def name
  @name
end

#server ⇒ Object (readonly)

The SNMP server to sent this alert



580
581
582
 
# File 'lib/nexpose/site.rb', line 580

def server
  @server
end

#type ⇒ Object (readonly)

The alert type



584
585
586
 
# File 'lib/nexpose/site.rb', line 584

def type
  @type
end

#vulnFilter ⇒ Object (readonly)

The vulnerability filter to trigger the alert



582
583
584
 
# File 'lib/nexpose/site.rb', line 582

def vulnFilter
  @vulnFilter
end

Instance Method Details

#setVulnFilter(vulnFilter) ⇒ Object

Sets the Vulnerability Filter for this alert.



597
598
599
 
# File 'lib/nexpose/site.rb', line 597

def setVulnFilter(vulnFilter)
  @vulnFilter = vulnFilter
end

#to_xml ⇒ Object 



601
602
603
604
605
606
607
608
609
610
 
# File 'lib/nexpose/site.rb', line 601

def to_xml
  xml = "<snmpAlert"
  xml << %Q{ name="#{replace_entities(name)}"}
  xml << %Q{ enabled="#{replace_entities(enabled)}"}
  xml << %Q{ community="#{replace_entities(community)}"}
  xml << %Q{ server="#{replace_entities(server)}">}
  xml << vulnFilter.to_xml
  xml << "</snmpAlert>"
  xml
end