Commits

Tim Tomes  committed 336aedf

updated documentation to reflect changes to the framework.

  • Participants
  • Parent commits 770426e

Comments (0)

Files changed (1)

         # 3. "yes" or "no" for whether or not the option is mandatory
         # 4. a description of the option
         self.register_option('nameserver', '8.8.8.8', 'yes', 'ip address of a valid nameserver')
-        # global options can be imported by referencing the self.goptions dictionary when registering options
+        # global options can be inherited by referencing the self.goptions dictionary when registering options
         self.register_option('verbose', self.goptions['verbose']['value'], 'yes', self.goptions['verbose']['desc'])
         # set module information here
         # do not remove or modify the key names
         self.info = {
                      'Name': 'Hostname Resolver',
                      'Author': 'Tim Tomes (@LaNMaSteR53)',
-                     'Description': 'Resolves IP addresses to hosts.',
+                     'Description': 'Resolves IP addresses to hosts and updates the database with the results.',
                      'Comments': [
                                   'Note: Nameserver must be in IP form.'
                                   ]
                      }
     # do not remove or rename
-    def do_run(self, params):
-        # do not remove or modify
-        if not self.validate_options(): return
-        # === begin module code here ===
-        # call the main method which will handle module logic
-        self.resolve_hosts()
-    
-    def resolve_hosts(self):
+    def module_run(self):
         # do something
         return
 }}}