7.2. Plugin Development

This section explains how to develop a new Plugin in the OpenNAC Enterprise environment.

All steps will be explained in detail. Anyway, the developer must have some basic knowledge in php7+ in order to understand the code and its explanations.

Warning

Non-certified plugins should NEVER be put into production. No support (neither normal nor 24/7) should be given to clients who incur in this action.

• 7.2.1. Plugin Type
  • 7.2.1.1. Asynchronous
  • 7.2.1.2. Synchronous
• 7.2.2. Create Plugin Files
  • 7.2.2.1. Plugin folder
  • 7.2.2.2. Plugin execution file
  • 7.2.2.3. Configuration params file
• 7.2.3. Fields in the JSON File
  • 7.2.3.1. Fields to define a new field
  • 7.2.3.2. Plugin’s description
• 7.2.4. Plugin Execution
  • 7.2.4.1. Class definition
  • 7.2.4.2. Extends class
  • 7.2.4.3. LOGS
  • 7.2.4.4. Required Methods
  • 7.2.4.5. Suggested methods
• 7.2.5. Plugin Usage
  • 7.2.5.1. Activate Plugin
  • 7.2.5.2. Edit Plugin
  • 7.2.5.3. Add Plugin to policy